-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Update vbus.md #5625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: current
Are you sure you want to change the base?
Update vbus.md #5625
Conversation
Deltasol BS (with VBUS) is also supported
WalkthroughA new DeltaSol BS device model entry is added to the VBus component documentation table, including configuration value, hexadecimal address, and descriptive notes for this supported device variant. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/components/vbus.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/vbus.md
🔇 Additional comments (1)
content/components/vbus.md (1)
27-27: Verify model support and implementation.Ensure that:
- The corresponding implementation in the esphome repository actually supports this new model with the config value
deltasol_bs_db.- The hex address
4278is correct.- All necessary sensor and binary sensor definitions are in place.
| | ---------------- | ---------------- | ----------- | ------------------- | | ||
| | DeltaSol BS Plus | deltasol_bs_plus | 4221 | | | ||
| | DeltaSol BS 2009 | deltasol_bs_2009 | 427B | DeltaSol BS Plus V2 | | ||
| | DeltaSol BS | deltasol_bs_db | 4278 | DeltaSol BS Drainb. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing documentation for supported sensors and binary sensors.
The new deltasol_bs_db model is added to the table but is not documented in the supported sensors (lines 125–128) or supported binary sensors (lines 175–179) sections. Users will not know which configuration options are available for this device.
Please add documentation clarifying which sensors and binary sensors are supported by deltasol_bs_db. For example:
- If it shares the same sensors as
deltasol_bs_plus, add it to that line. - If it has different support, add a dedicated line for it.
Similarly, update the binary sensors documentation if applicable.
🤖 Prompt for AI Agents
In content/components/vbus.md around lines 27 and extend to the supported
sensors section (lines 125–128) and supported binary sensors section (lines
175–179), add documentation for the new deltasol_bs_db model: state explicitly
which sensor entities and which binary_sensor entities it exposes; if it has
identical sensors to deltasol_bs_plus, append "deltasol_bs_db" to the same line
in the supported sensors list, otherwise add a new dedicated line listing each
sensor name, unit, and meaning; do the same for binary sensors (either add to
the deltasol_bs_plus binary sensor line or add a new line) so users can see
available configuration options for deltasol_bs_db.
Clarify abbreviated notes field.
The notes field reads "DeltaSol BS Drainb." which appears abbreviated. Is this "Drainback"? Please expand or clarify this notation for consistency and clarity.
🤖 Prompt for AI Agents
In content/components/vbus.md around line 27, the notes field "DeltaSol BS
Drainb." is an unclear abbreviation; replace "Drainb." with the full term
"Drainback" (or the correct full wording if different) so the entry reads
"DeltaSol BS Drainback." and then scan the file for other similar abbreviations
to standardize them for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deltasol BS (Drainback), such as COSMO BS with VBUS can be configured.
Please refer to: http://danielwippermann.github.io/resol-vbus/#/vsf/bytes/00_0010_4278_10_0100
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Fetch the packet definition from the provided URL
curl -s "http://danielwippermann.github.io/resol-vbus/vsf-data/bytes/00_0010_4278_10_0100.json"
Length of output: 9378
🏁 Script executed:
#!/bin/bash
# Try to fetch the VSF specification data from the GitHub repository
curl -s "https://raw.githubusercontent.com/danielwippermann/resol-vbus/master/src/specification-data.ts" | head -200
# Also try to find the packet definition in the VSF files
curl -s "https://api.github.com/repos/danielwippermann/resol-vbus/contents/src" | jq -r '.[].name' | grep -i spec
Length of output: 75
🏁 Script executed:
#!/bin/bash
# Try to fetch the VSF specification file
curl -s "https://raw.githubusercontent.com/danielwippermann/resol-vbus/master/src/vbus_specification.vsf" | grep -A 50 "4278" | head -100
# Also search for deltasol_bs references
curl -s "https://raw.githubusercontent.com/danielwippermann/resol-vbus/master/src/vbus_specification.vsf" | grep -i "deltasol.*bs" | head -20
Length of output: 43
🏁 Script executed:
#!/bin/bash
# Search for related ESPHome PRs that might implement deltasol_bs_db support
gh pr list --repo esphome/esphome --search "deltasol" --state all --limit 20 --json number,title,url,state
# Also search for recent commits mentioning deltasol or 4278
gh api /repos/esphome/esphome/commits --jq '.[] | select(.commit.message | test("deltasol|4278|bs_db"; "i")) | {message: .commit.message, url: .html_url}' | head -20
Length of output: 856
🏁 Script executed:
#!/bin/bash
# Search for deltasol_bs_db or 4278 in the esphome repository code
gh api /search/code?q=deltasol_bs_db+repo:esphome/esphome --jq '.items[] | {name: .name, path: .path, url: .html_url}'
# Also search for the hex address 4278
gh api /search/code?q=4278+repo:esphome/esphome+language:cpp --jq '.items[] | {name: .name, path: .path, url: .html_url}' | head -10
# Look for vbus.cpp or related implementation files
curl -s "https://raw.githubusercontent.com/esphome/esphome/dev/esphome/components/vbus/vbus.cpp" | grep -A 30 "4278\|deltasol_bs_db"
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Check the PR description for any linked PRs
gh pr view 5625 --repo esphome/esphome-docs --json body --jq '.body'
# Search for open PRs in esphome repo that might add this model
gh pr list --repo esphome/esphome --search "vbus" --state open --limit 10 --json number,title,url,body
# Also check recent vbus-related PRs
gh pr list --repo esphome/esphome --search "vbus" --state all --limit 10 --json number,title,url,state | jq '.'
Length of output: 3245
🏁 Script executed:
#!/bin/bash
# Check the current vbus component implementation in esphome/esphome dev branch
curl -s "https://raw.githubusercontent.com/esphome/esphome/dev/esphome/components/vbus/__init__.py" | grep -i "deltasol"
# Check for sensor definitions
curl -s "https://raw.githubusercontent.com/esphome/esphome/dev/esphome/components/vbus/sensor/__init__.py" | grep -A 5 -B 5 "4278\|deltasol_bs_db"
# Check binary sensor definitions
curl -s "https://raw.githubusercontent.com/esphome/esphome/dev/esphome/components/vbus/binary_sensor/__init__.py" | grep -A 5 -B 5 "4278\|deltasol_bs_db"
Length of output: 194
🏁 Script executed:
#!/bin/bash
# Search for any branches or recent activity related to deltasol_bs_db in the esphome repo
gh api /search/code?q=deltasol_bs_db+repo:esphome/esphome --jq '.total_count'
# Check if there are any open PRs from the same user (PJ-ESP-Delta) in esphome repo
gh pr list --repo esphome/esphome --author PJ-ESP-Delta --state all --limit 10 --json number,title,url,state,createdAt
# Also check recent commits from this user
gh api /repos/esphome/esphome/commits?author=PJ-ESP-Delta --jq '.[] | {message: .commit.message, date: .commit.author.date, url: .html_url}' | head -10
Length of output: 4
@PJ-ESP-Delta, thank you for clarifying that "Drainb." stands for "Drainback"!
However, I've checked the esphome/esphome repository and the deltasol_bs_db model doesn't appear to be implemented yet. Currently, only these models are supported in the code:
deltasol_bs_plusdeltasol_bs_2009deltasol_cdeltasol_cs2deltasol_cs_plus
Important questions:
-
Is there a corresponding PR in the esphome/esphome repository that adds the
deltasol_bs_dbimplementation? Your PR description mentions linking an esphome PR, but it's not filled in yet. -
Has the implementation been merged? If not, this documentation PR should wait until the code implementation is merged first. Otherwise, users will see this model in the documentation but won't be able to use it in their configurations (it will fail validation).
-
Which sensors and binary sensors does
deltasol_bs_dbsupport? This information is needed to complete the documentation sections at lines 125-128 (sensors) and lines 175-179 (binary sensors).
The typical workflow for adding new device support is:
- Submit PR to esphome/esphome with the implementation
- After that PR is merged, submit PR to esphome-docs with documentation
Could you please provide the link to the esphome PR that implements this model, or create one if it doesn't exist yet?
Deltasol BS (with VBUS) is also supported
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: